home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / gen_bbs / tgw5_10.zip / TGW5.DOC < prev    next >
Text File  |  1996-12-06  |  17KB  |  366 lines
  1.  
  2. │ TGW5 Version 1.0 Documentation
  3. │ (C) Copyright 1996, Brad Kaplan/Phoenix BBS Modifications.
  4. │ All Rights Reserved.
  5. │
  6. │ For Telegard 3.01+ systems (see details below).
  7. │
  8. │ Program released December 6, 1996
  9.  
  10.  
  11. WHAT IS TGW5?
  12. ───────────────────────────────────────────────────────────────────────────────
  13. TGW5 is a *simple* utility that allows you to modify Telegard's NODES.DAT
  14. file via the command line. The name stems from the '5 Ws' - who, what, where,
  15. when and why because it most accurately reflects what can be edited by TGW5
  16. along with the simple fact that I could not come up with something better.
  17.  
  18.  
  19. WHY IS TGW5?
  20. ───────────────────────────────────────────────────────────────────────────────
  21. I created TGW5 because of one small 'oversight' on Tim Strike's behalf with
  22. Telegard. When shelling out to an external door, Renegade BBS will not
  23. replace the 'status' in the who's online if a custom one is already provided.
  24. Unfortunately, this is not the case with Telegard (yet?). That is, regardless
  25. of what the status is set to via the NS menu keys prior to running an external
  26. door, Telegard will always set that node's status to 'External Door.' Because
  27. I like the ability to let other users know specifically where a node is (e.g,
  28. teleconference, a particular online game, etc.), there came the need to
  29. create something that could be run from a batch file to make these changes
  30. beyond Telegard's reach. Having accomplished this small task, I had no reason
  31. not to expand TGW5's capacity to being able to edit several other fields.
  32.  
  33.  
  34. WHO AM I?
  35. ───────────────────────────────────────────────────────────────────────────────
  36. I'm not really sure. I have been a SysOp (remotely and locally) off and on over
  37. a period of several years (dating back to Telegard 2.7). Upon its release, I
  38. had switched to and stuck primarily with Renegade. Telegard 3.0+ has since then
  39. shown me the light and I am dedicating all my resources (BBS wise) to Telegard.
  40.  
  41.  
  42. WHAT IS PHOENIX?
  43. ───────────────────────────────────────────────────────────────────────────────
  44. Phoenix really isn't. A couple of years ago, I co-founded a BBS modification
  45. group known as TRiC (The Renegade Information Crew). I had since then dropped
  46. out (sort of fell into obscurity) and needless to say am no longer affiliated
  47. with the group. However, I am toying the idea of creating my own group once
  48. again (Phoenix referring to the legendary bird that rises from its ashes) or
  49. affiliate myself with a group I would be comfortable being in (right now, both
  50. ACiDiC and X-Press Mods are considerations, so if they see me and are
  51. interested, please contact me). So as I am getting my stuff together to even
  52. bother to apply to either group, I'm crediting all my work thus far to Phoenix
  53. (if anyone is interested in joining such a venture, please contact me as well).
  54.  
  55.  
  56. HOW TO CONTACT ME
  57. ───────────────────────────────────────────────────────────────────────────────
  58. Right now, I may be reached via the internet at BsKResume@aol.com. I may also
  59. be able to provide support via the BBS I am remote SysOp of (203-368-1526) and
  60. I will hopefully start monitoring TG_SUPPORT actively.
  61.  
  62.  
  63. COPYRIGHT NOTICE AND LICENSE
  64. ───────────────────────────────────────────────────────────────────────────────
  65. TGW5 and its documentation are (C) Copyright 1996 by Brad Kaplan and Phoenix
  66. BBS Modifications. This documentation may not be produced in whole or in part
  67. without the expressed written consent of the author. Source code to this
  68. product is to be considered possession of solely the author and possession of
  69. such by any other individual obtained through either reversed engineering or
  70. other means without the expressed written consent of the author shall be
  71. considered theft and a direct violation of both this copyright and the license
  72. as described below.
  73.  
  74. You are licensed and given permission by the author to use this product freely
  75. as you see fit. You may also distribute the original archive containing only
  76. the original, unmodified files freely providing there is no fee associated
  77. with this package specifically. This product may also be distributed freely via
  78. electronic media such as CD-ROM providing the author has been contacted in
  79. advance far enough to provide a more up to date product.
  80.  
  81.  
  82. NOTES AND DISCLAIMER
  83. ───────────────────────────────────────────────────────────────────────────────
  84. This product is guaranteed to do nothing more than consume hard drive space.
  85. While as much testing was done as possible to ensure this product works as
  86. documented, there is always a distinct possibility that something has been
  87. overlooked, etc. Please contact the author at the address given above if any
  88. such problems are encountered but be forewarned that you will be using this
  89. product at your own risk and the author will not be held responsible for any
  90. damage to your system as a result - either directly or indirectly - from its
  91. use.
  92.  
  93. To make things worse, this is my first Telegard utility and I've literally
  94. written it overnite. That is, a lot of what this product does was new to me and
  95. I've tried to adapt as best I could, but I can offer no promises.
  96.  
  97. Also, there is a very slim chance this will ever be a problem due to the
  98. nature of this product, but I am not sure what the results will be if this
  99. product is executed while the nodes.dat file is already opened. I imagine it
  100. will be denied its read/write access and will abort with an error. I would
  101. greatly appreciate it if someone with more experience can contact me and give
  102. me some ideas on how to address that sort of situation. Thanks in advance.
  103.  
  104.  
  105. WHAT TGW5 CAN'T MODIFY
  106. ───────────────────────────────────────────────────────────────────────────────
  107. TGW5 currently does not support the modification of attributes specific to that
  108. node which would otherwise be accomplished through the node manager with the
  109. exception of the available flag.
  110.  
  111. Logon time may not be modified through TGW5 because of the feasibility (or
  112. lack thereof) of inputting the time and date of login while enforcing some
  113. reality.
  114.  
  115. The IsHidden and IsQuiet flags are not supported. As it is, I'm not even sure
  116. Telegard supports these fully yet. Also, reserved are not supported.
  117.  
  118.  
  119. USING TGW5
  120. ───────────────────────────────────────────────────────────────────────────────
  121. As TGW5 is a simple program, it stands to reason its use would also be
  122. relatively simple. Its basic syntax is as follows:
  123.  
  124. SYNTAX: TGW5 /Nx [/C<path>] [/A<+|-|!>] [/B<bps>] [/H<handle>]
  125.         [/I<status id>] [/L<location>] [/R<real name>] [/S<status>]
  126.  
  127. The only required parameter is /Nx where x is the node you wish to modify or 0
  128. to modify *all* nodes. There is no specific order in which you must provide the
  129. parameters.
  130.  
  131. The rest of the parameters are described below:
  132.  
  133.  
  134. /C<path> - PATH TO NODES.DAT
  135. ───────────────────────────────────────────────────────────────────────────────
  136. TGW5 needs to know the location of the NODES.DAT file (located in your BBS's
  137. DATA subdirectory). If NODES.DAT is in the current directory when you execute
  138. TGW5, this parameter is not necessary. Otherwise, you will need to indicate
  139. where NODES.DAT may be found. For example, if your NODES.DAT file is located in
  140. C:\TG\DATA, your command line might look something like:
  141.  
  142. TGW5 /N1 /CC:\TG\DATA\ /S"Online Game"
  143.  
  144. Including the reverse slash (\) at the end of the path is optional - TGW5 will
  145. automatically add it if you don't.
  146.  
  147.  
  148. /A<+|-|!> - AVAILABLE FLAG SETTING
  149. ───────────────────────────────────────────────────────────────────────────────
  150. This option will affect the available flag for the specified node(s). When a
  151. node is flagged as unavailable, it will not be able to accept calls (as you will
  152. not be able to load Telegard with that node), nor will it be displayed in the
  153. who's online listing.
  154.  
  155. The /A is followed by a single character - either a plus (+), a minus (-) or an
  156. exclamation point (!) which makes the specified node(s) active, not active or
  157. toggles its/their status respectively. For example:
  158.  
  159. TGW5 /N0 /A+
  160.  
  161. will make *all* nodes active, while:
  162.  
  163. TGW5 /N2 /A-
  164.  
  165. will make Node 2 NOT active, and:
  166.  
  167. TGW5 /N0 /A!
  168.  
  169. will TOGGLE (reverse) the active status for all nodes. Given the above
  170. examples, all nodes will no longer be active except for Node 2 which will now
  171. be active.
  172.  
  173. For your convenience, plus (+) may be substituted with 1 (the binary bit for
  174. on), Y (for Yes) or T (for True). The minus (-) may also be substituted with
  175. the plus' respective opposites (0, N and F).
  176.  
  177.  
  178. /B<bps rate> - BPS RATE
  179. ───────────────────────────────────────────────────────────────────────────────
  180. This will allow you to adjust the BPS rate for the specified node(s). For
  181. obvious reasons, it is recommended you do not adjust the BPS rate for a node
  182. on which there is already a user. An example would be:
  183.  
  184. TGW5 /N2 /B14400
  185.  
  186. Which would set the baud rate for Node 2 to 14400.
  187.  
  188. A specified baud rate of 0 will result as 'Local.'
  189.  
  190.  
  191. /H<handle> - HANDLE - MAXIMUM 36 CHARACTERS
  192. ───────────────────────────────────────────────────────────────────────────────
  193. This will allow you to modify the Handle of the 'user' on the node(s)
  194. specified. The only thing to note here is that if you wish to include spaces in
  195. the new handle, you must enclose the entire handle in quotes ("). For example:
  196.  
  197. TGW5 /N3 /H"Brad Kaplan"
  198.  
  199. will set the 'handle' of the user on node 3 to Brad Kaplan. If no space was
  200. being used in the new handle, the quotes would not be necessary, e.g.:
  201.  
  202. TGW5 /N3 /HBrad
  203.  
  204. A really interesting use for this option may be to replace the Waiting For Call
  205. on an empty node with the node's phone number (providing you have the
  206. appropriate lines configured to display handles in your language file).
  207.  
  208.  
  209. /I<status id> - STATUS ID
  210. ───────────────────────────────────────────────────────────────────────────────
  211. This will set the Status ID of the specified node(s). The Status ID is a number
  212. between 0 and 4 which refer to the following settings:
  213.  
  214. 0 - The node is waiting for a call.
  215. 1 - The node is marked as offline/down.
  216. 2 - The node is in an event.
  217. 3 - There is a user connected on this node.
  218. 4 - The node is waiting to be reset.
  219.  
  220. It is imperative that you maintain necessary precautions and discretions when
  221. modifying the Status ID for a particular node and return the ID back to its
  222. original state when you've finished doing what you're doing with it.
  223.  
  224.  
  225. /L<location> - LOCATION OF USER - MAXIMUM 30 CHARACTERS
  226. ───────────────────────────────────────────────────────────────────────────────
  227. This will set the geographic location (city, state/whatever) of the specified
  228. node(s). See /H<handle> for example and notes regarding use of spaces.
  229.  
  230.  
  231. /S<status> - STATUS OF USER - MAXIMUM 36 CHARACTERS
  232. ───────────────────────────────────────────────────────────────────────────────
  233. This will set the status (location on BBS, what the user is doing, etc.) of the
  234. specified node(s). See /H<handle> for example and notes regarding use of spaces.
  235.  
  236.  
  237. /R<real name> - REAL NAME OF USER - MAXIMUM 36 CHARACTERS
  238. ───────────────────────────────────────────────────────────────────────────────
  239. This will set the real name of the specified node(s). See /H<handle> for
  240. example and notes regarding use of spaces.
  241.  
  242.  
  243. SPECIAL NOTES AND CONSIDERATIONS
  244. ───────────────────────────────────────────────────────────────────────────────
  245. Remember, when you modify items such as the Handle or Location, etc., you are
  246. not actually modifying the physical user record - just what users will see when
  247. they do a who's online. Coupled with a script to input for parameters that can
  248. be passed on to TGW5, one could have a lot of fun with users if one desired (or
  249. allow users to battle it out amongst themselves).
  250.  
  251. Also, remember that all you will be able to see in the who's online listing is
  252. what your language file is configured to show. So if your who's online doesn't
  253. show the BPS rate of the node, there is no point to actually modifying it.
  254.  
  255. Finally, remember that there may be leftover data from the user previously on
  256. the node(s) you are modifying. Be sure to modify enough parameters
  257. appropriately so your who's online doesn't include this left over 'junk.'
  258.  
  259.  
  260. OTHER PROGRAMS WHICH MODIFY NODES.DAT
  261. ───────────────────────────────────────────────────────────────────────────────
  262. The following programs are ones I have had the pleasure of using prior to the
  263. development of TGW5. With no disrespect to their respective authors, I have
  264. provided a brief explanation of what each program does and (where possible) a
  265. way to accomplish the same using TGW5. Please do not take offense if you have
  266. written a program to modify NODES.DAT and I haven't mentioned it. I am able to
  267. list only those programs and versions I am privy to accessing.
  268.  
  269.  
  270. PSYCH0MULTINODEMESSENGER/TG .50 (Andrew H. Ziem - ziem@rmii.com)
  271. ───────────────────────────────────────────────────────────────────────────────
  272. WHAT IT DOES:
  273. PMM allows you to view who is online, edit users, create 'fake' users and
  274. message users. I have not seen any other version (either prior to .50 or
  275. later - .50 was the latest version I could find as of 12/06/96), but this
  276. particular version only allows you to send online messages to users
  277. (according to its documentation).
  278.  
  279. WHAT IT REALLY DOES:
  280. As its only function at this time is to message users, a description of what
  281. the program actually does is beyond the scope of TGW5 and its documentation.
  282.  
  283. HOW YOU CAN DO IT WITH TGW5:
  284. Because the possibilities here are 'limitless' and subject to how your
  285. language files' representations of the who's online are configured, no
  286. example will be provided. However, any switches for TGW5 are applicable and
  287. should otherwise be documented.
  288.  
  289.  
  290. TELEGARD NODE ACTIVITY TOGGLE 1.0 (Dark Zone Software - krawlur@brewich.com)
  291. ───────────────────────────────────────────────────────────────────────────────
  292. WHAT IT DOES:
  293. This utility allows you to toggle the active status of a specified node. It's
  294. essentially the author's response to those who have inadvertently toggled
  295. all of their nodes (on multi-node systems) to inactive status and thus are
  296. unable to load Telegard without resorting to deleting the NODES.DAT file
  297. altogether. For all I know, this may also come in handy in other places as
  298. well (such as making a local node 'temporary' by having the batch file turn
  299. the node on before running Telegard).
  300.  
  301. WHAT IT REALLY DOES:
  302. It toggles the Active flag of the specified node. I.E., if the specified
  303. node is marked as inactive, it now becomes active. If the specified node is
  304. marked as active, it now becomes inactive.
  305.  
  306. HOW YOU CAN DO IT WITH TGW5:
  307. Although TGW5 goes one step further, allowing you to specify whether the node
  308. is active or inactive (as opposed to getting 'lucky' in automated processes),
  309. it does support the same treatment as TGNAT. For example, the following
  310. command line will toggle the Active flag of node 1:
  311.  
  312. TGW5 /N1 /A!
  313.  
  314.  
  315. TELEGARD NODES.DAT UPDATER 1.1 (Francis Julien - 1:242/510)
  316. ───────────────────────────────────────────────────────────────────────────────
  317. WHAT IT DOES:
  318. Allows you to modify the Status ID and Baudrate of the specified node.
  319.  
  320. WHAT IT REALLY DOES:
  321. See above.
  322.  
  323. HOW YOU CAN DO IT WITH TGW5:
  324. The following example will set node 2 to 'event' status and indicate to the
  325. user that the node's maximum baud rate is 28800.
  326.  
  327. TGW5 /N2 /I2 /B28800
  328.  
  329.  
  330. TELEGARD ALTERWHO 1.0 (Steve Adams - TGUtils@aceshigh.gryn.org)
  331. ───────────────────────────────────────────────────────────────────────────────
  332. WHAT IT DOES:
  333. This utility allows you to customize the 'status' of a node, e.g.: 
  334.  
  335. Node  Name                         Speed  Status           Location
  336. ===== ============================ ====== ================ ==================
  337. 1     Offline/Unavailable          -      -                -
  338. 2     Joe Sysop                    Local  Browsing         Anytown, Anywhere
  339. 3     BinkleyTerm Executed         Local  Alterwho v1.0    By Steve Adams
  340.  
  341. WHAT IT REALLY DOES:
  342. It modifies the Status ID of the specified node to the Connected state (3)
  343. to force TG into displaying the information for the node. It also modifies
  344. the handle (real name as well?), status and location where your specified
  345. text goes into the handle position and a little self-promotion into the
  346. status and location fields.
  347.  
  348. HOW YOU CAN DO IT WITH TGW5:
  349. The following command line will yield the same results as those displayed
  350. above (minus the advertisement):
  351.  
  352. TGW5 /N3 /I3 /H"BinkleyTerm Executed"
  353.  
  354. The *exact* same results (advertisement and all) can be achieved with:
  355.  
  356. TGW5 /N3 /I3 /H"BinkleyTerm Executed" /S"Alterwho v1.0" /L"By Steve Adams"
  357.  
  358. Just be sure that you return the ID back to what it should be (normally 0)
  359. when whatever is finished.
  360.  
  361.  
  362. OTHER COPYRIGHTS
  363. ───────────────────────────────────────────────────────────────────────────────
  364. Telegard is (C) Copyright Timothy Strike. Renegade is (C) Copyright Cott Lang.
  365. All other products are copyrighted their respective authors.
  366.